Broadband Checker Business API
How to use the API
The table below outlines how different parts of the Broadband Checker Business API operate, and how each part can be used.
| API Function | How it works | What it can be used for |
|---|---|---|
| Retrieve business product availability and feature information | A Chorus identifier in the form of either TLC or PLSAM is provided and the business service availability and feature information is returned. | Enables an external application to use the API to retrieve business service availability and feature information. |
The table below provides the meaning of different values returned from the Broadband Checker Business API.
| Data Group | Field | Description | Data Type | Example Values |
|---|---|---|---|---|
| Current Business Services | Maximum Current Service | The highest ranked Chorus business service that is currently active at the address. The business services in scope are listed here from lowest to highest:
|
String | NGA Business |
| Current Business Services | Minimum Current Service | The lowest ranked Chorus business service that is currently active at the address. | String | EUBA |
| Current Business Services | Number of Services | The number of current active service instances. | Number | 2 |
| Address | TLC | Telecom Location Code. A unique address identifier used in fibre systems. Contains nine numeric characters. | Number | 100002540 |
| Address | PLSAM | POTS Line Service Area Master. A unique address identifier used in copper systems such as ICMS and Wireline. Also known as SAM ID. Note: Must be a number between 1 ā 9999999. | Number | 320761 |
| Address | Premise Wiring Recommended | Where the address is VDSL capable, this field will indicate whether a Connection and Wiring field service is strongly recommended to achieve the VDSL speed benefits. | String | "Y", "N" |
| Address | Fibre Category | Category of fibre install at the address which can be used to get an indicative cost of connection, using the information in the product section. | String | Standard, category1, category2 |
| Address | Fibre Candidate Area Code | The area code for the candidate area, as per the UFB partnerships. | String | 32, 2, N/A |
| Address | Fibre Candidate Area Name | The name for the candidate area, as per the UFB partnerships. | String | Dunedin |
| Address | Fibre Candidate Area Supplier | The LFC supplier for the candidate area, as per the UFB partnerships. | String | Chorus Limited, Not Applicable |
| Address | WGS84 Latitude | World Geodetic System (as used on GPS systems and Google) latitude coordinates. | Number | -45.8680296 |
| Address | WGS84 Longitude | World Geodetic System (as used on GPS systems and Google) longitude coordinates. | Number | 170.5147039 |
| Address | Nbap | Flag indicating whether this address is a non-building access point, e.g. a traffic light, or cellsite. | String | āYā, āNā |
| Address | Intact ONT | Flag indicating whether there is an intact (active or inactive) ONT at the address. | String | āYā, āNā |
| Address | Fibre Availability Date | The predicted date that UFB fibre will be available at the address. | String | 2019-06-30 |
| Address | ffpID | Indicates the FFP a given Address is connected to. | String | "F-AEW568" |
| Address | fibreUnbundlingEnabled | Indicates if a given address is eligible for fibre unbundling. | String | "Y", "N" |
| Address | fibreUnbundlingDate | Indicates the fibre unbundling date if a given address is eligible for fibre unbundling. | String | "2020-01-01" |
| Location Product Availability | Name | The name of the product. | String | EUBA |
| Location Product Availability | Available | A flag that determines whether the product is available at the address. For copper products, an āIā flag indicates Inconclusive. This means that the availability could not be determined automatically and, to get a conclusive result, a manual prequalification request will need to be raised. | String | āYā, āNā, āIā |
| Location Product Availability | Central Office Code | The code for the location where the access product is aggregated for carriage back to the handover. | String | MOD |
| Location Product Availability | Central Office Name | The name for the Central Office code. | String | MOUNT EDEN |
| Location Product Availability | Guaranteed Download Speed | The guaranteed download speed for the product at this location. This is the bandwidth that is guaranteed to be delivered between the handover and the address. | String | 2.5 |
| Location Product Availability | Guaranteed Upload Speed | The guaranteed upload speed for the product at this location. This is the bandwidth that is guaranteed to be delivered between the address and the handover. | String | 2.5 |
| Location Product Availability | Lead Time | The lead time in business days for the product, with business days being Monday ā Friday (excluding holidays) for a standard install of the product at the address. Lead time is determined by the Chorus infrastructure serving the address. | Number | 6 |
| Location Product Availability | Lead Time Type | The lead time type indicates the source of the lead time. Where the lead time is standard (for the conditions at the address), then the lead time type is STANDARD and does not specifically take into account existing workload. Where the lead time type is CURRENT, it reflects existing workloads and may be shorter or longer than a standard lead time. | String | CURRENT, STANDARD |
| Location Product Availability | Local POI Code | The Local Point of Interconnect code. This is the code for the location where the access product is made available for handover without any Tail Extension or other backhaul being used. | String | WLG/PRO |
| Location Product Availability | Local POI Name | The name for the Local Point of Interconnect code. | String | WELLINGTON/PORIRUA |
| Location Product Availability | Remote POI Code | The Remote Point of Interconnect code. This is the code for the location where the access product can be carried using Tail Extension. | String | WLG/PRO |
| Location Product Availability | Remote POI Name | The name for the Remote Point of Interconnect code. | String | WELLINGTON/PORIRUA |
| Location Product Availability | Status | The Status of the product availability at the address. This indicates the activity/work that would be required to deliver the product to the address. | String | READY, UNDER BUILD, CONSENT REQUIRED Category1 |
| Location Product Availability | Unguaranteed Download Speed | The Unguaranteed Download Speed for the product at this location between the handover and the address. This is the bandwidth that is subject to contention, either on the access or aggregation network (or both) and therefore cannot be guaranteed at any time (although, it will be available at uncontended times). | String | 100 |
| Location Product Availability | Unguaranteed Upload Speed | The Unguaranteed Upload Speed for the product at this location between the address and the handover. This is the bandwidth that is subject to contention either on the access or aggregation network (or both) and therefore cannot be guaranteed at any time (although, it will be available at uncontended times). | String | 100 |
| Product | Name | The name of the product. Note: This can change over time, if the product is renamed. | String | EUBA |
| Product | Product Group | The group to which the product belongs. | String | Copper, NGA, L1 |
| Product | Symmetric | Symmetric illustrates whether the downstream and upstream bandwidth are aligned or are skewed in favour of one direction. | String | Symmetric, Asymmetric |
| Product | Adaptive | Adaptive illustrates the nature of the product. Adaptive products adapt to the conditions under which they operate and, as such, bandwidths can rise or fall. Fixed products are only delivered to addresses where the bandwidths offered can always be delivered. | String | Fixed, Adaptive |
| Product | Diversity | Diversity indicates the product has a diverse offering (2 accesses), which provides resilience if there is a problem with one access. | String | āYā, āNā |
| Product | Field Assure | Field Assure for the product illustrates the hours during which field services technicians operate to resolve faults. | String | 7x7x7 |
| Product | Multi Class | The Multi-Class flag indicates the product offers multiple class of service options, which allows the Service Provider the opportunity to prioritise traffic within the Chorus network. | String | āYā, āNā |
| Product | OAM | The OAM flag illustrates whether the product provides for Operations, Administration and Management functions, which allows the Service Provider to check the operation of the Chorus network for the product. | String | āYā, āNā |
| Product | Remote Assure | Remote Assure for the product illustrates the hours during which remote Chorus technicians operate to diagnose and resolve faults for the product. Note: This is not a guarantee and does not affect the SLA hours and commitments that relate to the product. | String | 24x7 |
| Product | Remote Assure Priority | Remote Assure Priority illustrates the priority in which faults will be diagnosed/resolved when Chorus technicians are dealing with multiple faults for multiple products. Note: This does not affect the SLA hours and commitments that relate to the product. | String | 2 |
| Product | Restoration Target | The Restoration Target for the product states the number of hours that Chorus targets to resolve faults with the product. | String | 8 |
| Product | Connect Cost (Standard) | The Connect Cost for the product at a standard location. This reflects the cost of a standard install for the product at the location but can only be confirmed when an order has been placed and the scope has confirmed that the install is standard. | String | 710 |
| Product | Connect Cost (category1) | The Connect Cost for the product at a category 1 location, as identified in the fibre category field in the Address data group. Note: This reflects the cost of a standard install for the product at the location but can only be confirmed when an order has been placed and the scope has confirmed that the install is a standard category 1 install. | String | 15000 |
| Product | Connect Cost (category2) | The Connect Cost for the product at a category 2 location, as identified in the fibre category field in the Address data group. Note: This reflects the cost of a standard install for the product at the location but can only be confirmed when an order has been placed and the scope has confirmed that the install is a standard category 2 install. | String | 10000 |
| Product | Connect Cost (category3) | The Connect Cost for the product at a category3 location as identified in the fibre category field in the Address data group. Note: This reflects the cost of a standard install for the product at the location but can only be confirmed when an order has been placed and the scope has confirmed that the install is a standard category 3 install. | String | 5000 |
| Product | Recurring Cost (low) | The Recurring Cost (low) represents the minimum monthly recurring cost being charged for an active product instance of the product. Note: This includes access and service bandwidth charges but does not include any tail extension. | String | 295 |
| Product | Recurring Cost (high) | The Recurring Cost (high) represents the maximum monthly recurring cost being charged for an active product instance of the product. Note: This includes access and service bandwidth charges but does not include any tail extension. | String | 710 |
| Product | Recurring Cost (mode) | The Recurring Cost (mode) represents the most common monthly recurring cost being charged for active product instances of the product. Note: This includes access and service bandwidth charges but does not include any tail extension. | String | 350 |